Add Water Content Measurement clusters #59300

majkrzak · 2021-11-07T18:01:27Z

Proposed change

Ads missing Water Content Measurement clusters: Soil Moisture and Leaf Wetness

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

It requires zigpy/zigpy#844 to be first pulled into the core.
The Soil Moisture part was tested with https://github.com/smartboxchannel/Plant-Watering-Sensor-Zigbee, and seems to be working. Leaf Moisture was not tested, but according to the zcl specs it should behave in the very same way.
I think that I have added new clusters in all the places they are supposed to be.
Requires #59314 to be merged first.

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
The code has been formatted using Black (black --fast homeassistant tests)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

No score or internal
🥈 Silver
🥇 Gold
🏆 Platinum

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

probot-home-assistant · 2021-11-07T18:01:32Z

Hey there @dmulcahey, @Adminiuga, mind taking a look at this pull request as it has been labeled with an integration (zha) you are listed as a code owner for? Thanks!
_{^{(message by CodeOwnersMention)}}

Adminiuga

Lgtm. Can you post the device signature?
I'd like to add it to the list of test devices

majkrzak · 2021-11-07T18:15:09Z

@Adminiuga do you meen this?

{
  "node_descriptor": "NodeDescriptor(logical_type=<LogicalType.EndDevice: 2>, complex_descriptor_available=0, user_descriptor_available=0, reserved=0, aps_flags=0, frequency_band=<FrequencyBand.Freq2400MHz: 8>, mac_capability_flags=<MACCapabilityFlags.AllocateAddress: 128>, manufacturer_code=0, maximum_buffer_size=80, maximum_incoming_transfer_size=160, server_mask=0, maximum_outgoing_transfer_size=160, descriptor_capability_field=<DescriptorCapability.NONE: 0>, *allocate_address=True, *is_alternate_pan_coordinator=False, *is_coordinator=False, *is_end_device=True, *is_full_function_device=False, *is_mains_powered=False, *is_receiver_on_when_idle=False, *is_router=False, *is_security_capable=False)",
  "endpoints": {
    "1": {
      "profile_id": 260,
      "device_type": "0x000c",
      "in_clusters": [
        "0x0000",
        "0x0001",
        "0x0402",
        "0x0408"
      ],
      "out_clusters": []
    }
  },
  "manufacturer": "efektalab.ru",
  "model": "EFEKTA_PWS",
  "class": "zigpy.device.Device"
}```

majkrzak · 2021-11-07T18:17:29Z

About "lgtm": it requires the zigpy version to be bumped correctly in the manifest, as now it will most likely crash the component due to the measurement.SoilMoisture.cluster_id for example.

Adminiuga · 2021-11-07T18:17:53Z

Yes. I'll add it to the test ZigBee devices list tonight, as I think this is a first such device in the list.

Adminiuga · 2021-11-07T21:38:06Z

About "lgtm": it requires the zigpy version to be bumped correctly in the manifest, as now it will most likely crash the component due to the measurement.SoilMoisture.cluster_id for example.

yeah, need to publish zigpy and bump up ZHA dependencies first.

Adminiuga · 2021-11-07T22:25:40Z

can you add the following diff to your PR? Or I could submit a PR to your branch

--- a/tests/components/zha/zha_devices_list.py
+++ b/tests/components/zha/zha_devices_list.py
@@ -3985,4 +3985,42 @@ DEVICES = [
         SIG_MODEL: "XBee3",
         SIG_NODE_DESC: b"\x01@\x8e\x1e\x10R\xff\x00\x00,\xff\x00\x00",
     },
+    {
+        DEV_SIG_DEV_NO: 99,
+        SIG_ENDPOINTS: {
+            1: {
+                SIG_EP_TYPE: 0x000c,
+                DEV_SIG_EP_ID: 1,
+                SIG_EP_INPUT: [0x0000, 0x0001, 0x0402, 0x0408],
+                SIG_EP_OUTPUT: [],
+                SIG_EP_PROFILE: 260,
+            }
+        },
+        DEV_SIG_ENTITIES: [
+            "sensor.efektalab_ru_efekta_pws_77665544_power",
+            "sensor.efektalab_ru_efekta_pws_77665544_temperature",
+            "sensor.efektalab_ru_efekta_pws_77665544_soil_moisture",
+        ],
+        DEV_SIG_ENT_MAP: {
+            ("sensor", "00:11:22:33:44:55:66:77-1-1"): {
+                DEV_SIG_CHANNELS: ["power"],
+                DEV_SIG_ENT_MAP_CLASS: "Battery",
+                DEV_SIG_ENT_MAP_ID: "sensor.efektalab_ru_efekta_pws_77665544_power",
+            },
+            ("sensor", "00:11:22:33:44:55:66:77-1-1026"): {
+                DEV_SIG_CHANNELS: ["temperature"],
+                DEV_SIG_ENT_MAP_CLASS: "Temperature",
+                DEV_SIG_ENT_MAP_ID: "sensor.efektalab_ru_efekta_pws_77665544_temperature",
+            },
+            ("sensor", "00:11:22:33:44:55:66:77-1-1032"): {
+                DEV_SIG_CHANNELS: ["soil_moisture"],
+                DEV_SIG_ENT_MAP_CLASS: "SoilMoisture",
+                DEV_SIG_ENT_MAP_ID: "sensor.efektalab_ru_efekta_pws_77665544_soil_moisture",
+            },
+        },
+        DEV_SIG_EVT_CHANNELS: [],
+        SIG_MANUFACTURER: "efektalab.ru",
+        SIG_MODEL: "EFEKTA_PWS",
+        SIG_NODE_DESC: b"\x02@\x80\x00\x00P\xa0\x00\x00\x00\xa0\x00\x00",
+    },
 ]

Adminiuga · 2021-11-07T22:45:16Z

once #59314 gets merged, rebase against the dev.

Adminiuga · 2021-11-08T13:01:14Z

ZHA dependencies were updated. Please rebase against the current upstream dev and force push.

majkrzak · 2021-11-08T15:49:00Z

can you add the following diff to your PR? Or I could submit a PR to your branc
ZHA dependencies were updated. Please rebase against the current upstream dev and force push.
@Adminiuga done

Adminiuga

Lgtm

majkrzak requested review from Adminiuga and dmulcahey as code owners November 7, 2021 18:01

homeassistant added the cla-signed label Nov 7, 2021

probot-home-assistant bot added integration: zha new-feature labels Nov 7, 2021

probot-home-assistant bot assigned Adminiuga and dmulcahey Nov 7, 2021

project-bot bot added this to Needs review in Dev Nov 7, 2021

Adminiuga reviewed Nov 7, 2021

View reviewed changes

Adminiuga mentioned this pull request Nov 7, 2021

Bump up ZHA dependencies #59314

Merged

22 tasks

majkrzak and others added 3 commits November 8, 2021 16:42

Add Water Content Measurement clusters

318b4df

Fix typo

a561094

Add device test

c25930f

Adminiuga approved these changes Nov 8, 2021

View reviewed changes

Dev automation moved this from Needs review to Reviewer approved Nov 8, 2021

Adminiuga merged commit 80f1e87 into home-assistant:dev Nov 8, 2021

Dev automation moved this from Reviewer approved to Done Nov 8, 2021

majkrzak deleted the zha/add-water-content branch November 8, 2021 18:47

github-actions bot locked and limited conversation to collaborators Nov 9, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Water Content Measurement clusters #59300

Add Water Content Measurement clusters #59300

majkrzak commented Nov 7, 2021 •

edited by Adminiuga

probot-home-assistant bot commented Nov 7, 2021

Adminiuga left a comment

majkrzak commented Nov 7, 2021

majkrzak commented Nov 7, 2021

Adminiuga commented Nov 7, 2021

Adminiuga commented Nov 7, 2021

Adminiuga commented Nov 7, 2021

Adminiuga commented Nov 7, 2021

Adminiuga commented Nov 8, 2021

majkrzak commented Nov 8, 2021

Adminiuga left a comment

Add Water Content Measurement clusters #59300

Add Water Content Measurement clusters #59300

Conversation

majkrzak commented Nov 7, 2021 • edited by Adminiuga

Proposed change

Type of change

Additional information

Checklist

probot-home-assistant bot commented Nov 7, 2021

Adminiuga left a comment

Choose a reason for hiding this comment

majkrzak commented Nov 7, 2021

majkrzak commented Nov 7, 2021

Adminiuga commented Nov 7, 2021

Adminiuga commented Nov 7, 2021

Adminiuga commented Nov 7, 2021

Adminiuga commented Nov 7, 2021

Adminiuga commented Nov 8, 2021

majkrzak commented Nov 8, 2021

Adminiuga left a comment

Choose a reason for hiding this comment

majkrzak commented Nov 7, 2021 •

edited by Adminiuga